.TH "Zebulon::CoralAHRS::Configuration" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::CoralAHRS::Configuration \- 
.PP
This packet is sent in reponse to a CORAL REQUEST CONFIGURATION packet. It returns the current serial speed setting, output mode, and output rate divisor. The output mode setting is 1 for CORAL QUAT output mode, 2 for CORAL SENSORS output mode, 3 for (CORAL SENSORS | CORAL QUAT) output mode, 4 for CORAL RAW SENSORS, and 0 for no output. The serial speed setting corresponds to an actual baud rate according to the following chart:
.IP "\(bu" 2
0 = 4800
.IP "\(bu" 2
1 = 9600
.IP "\(bu" 2
2 = 19200
.IP "\(bu" 2
3 = 38400
.IP "\(bu" 2
4 = 57600
.IP "\(bu" 2
5 = 115200
.IP "\(bu" 2
6 = 230400
.IP "\(bu" 2
7 = 460800. 
.PP
 

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <configuration.h>\fP
.PP
Inherits \fBZebulon::CoralAHRS::Message\fP.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBConfiguration\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBConfiguration\fP (const \fBConfiguration\fP &message)"
.br
.RI "\fICopy constructor. \fP"
.ti -1c
.RI "\fB~Configuration\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual int \fBWriteMessageBody\fP (CxUtils::Packet &packet) const "
.br
.RI "\fIWrites contents of message body to packet. \fP"
.ti -1c
.RI "virtual int \fBReadMessageBody\fP (const CxUtils::Packet &packet)"
.br
.RI "\fIReads contents of message body from the packet, saving to internal data members. \fP"
.ti -1c
.RI "virtual \fBMessage\fP * \fBClone\fP () const "
.br
.ti -1c
.RI "virtual void \fBPrint\fP () const "
.br
.RI "\fIPrints data to console window. \fP"
.ti -1c
.RI "\fBConfiguration\fP & \fBoperator=\fP (const \fBConfiguration\fP &message)"
.br
.RI "\fISets equal to. \fP"
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "unsigned char \fBmSerialSpeed\fP"
.br
.ti -1c
.RI "unsigned char \fBmOutputMode\fP"
.br
.ti -1c
.RI "unsigned char \fBmOutputRateDivisor\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This packet is sent in reponse to a CORAL REQUEST CONFIGURATION packet. It returns the current serial speed setting, output mode, and output rate divisor. The output mode setting is 1 for CORAL QUAT output mode, 2 for CORAL SENSORS output mode, 3 for (CORAL SENSORS | CORAL QUAT) output mode, 4 for CORAL RAW SENSORS, and 0 for no output. The serial speed setting corresponds to an actual baud rate according to the following chart:
.IP "\(bu" 2
0 = 4800
.IP "\(bu" 2
1 = 9600
.IP "\(bu" 2
2 = 19200
.IP "\(bu" 2
3 = 38400
.IP "\(bu" 2
4 = 57600
.IP "\(bu" 2
5 = 115200
.IP "\(bu" 2
6 = 230400
.IP "\(bu" 2
7 = 460800. 
.PP

.SH "Member Function Documentation"
.PP 
.SS "int Configuration::ReadMessageBody (const CxUtils::Packet & packet)\fC [virtual]\fP"
.PP
Reads contents of message body from the packet, saving to internal data members. \fBParameters:\fP
.RS 4
\fIpacket\fP The packet to read data from.
.RE
.PP
\fBReturns:\fP
.RS 4
Number of bytes read from packet. 
.RE
.PP

.PP
Implements \fBZebulon::CoralAHRS::Message\fP.
.SS "int Configuration::WriteMessageBody (CxUtils::Packet & packet) const\fC [virtual]\fP"
.PP
Writes contents of message body to packet. \fBParameters:\fP
.RS 4
\fIpacket\fP The packet to write data to.
.RE
.PP
\fBReturns:\fP
.RS 4
Number of bytes written to packet. 
.RE
.PP

.PP
Implements \fBZebulon::CoralAHRS::Message\fP.

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
